﻿==============================================================
 Cliply User Guide
 A command snippet notebook for developers (Windows 10 / 11, 64-bit)
==============================================================

Keep the PowerShell, Docker, SQL, Bash and Git commands you use often,
then find and copy them from any program with a single shortcut.

  Shortcut (Ctrl+Shift+Space) → type to search → Enter → Ctrl+V in your app


--------------------------------------------------------------
1. Install and run
--------------------------------------------------------------

There is no installer, and you don't need .NET or anything else.

  1) Right-click the downloaded zip → [Properties] → check [Unblock]
     at the bottom → [OK]
     (This clears the "downloaded from the internet" mark Windows adds.)

  2) Extract the zip to any folder, e.g. C:\Tools\Cliply

  3) Run Cliply.exe

  4) No window opens. A blue >_ icon appears in the notification area
     (system tray) at the bottom right of the taskbar. If you don't see
     it, click ^ to show hidden icons.

[If "Windows protected your PC" appears the first time]
  Cliply is not code-signed, so Windows SmartScreen shows a warning.
  Click [More info] → [Run anyway]. You only need to do this once.
  To check that the file is genuine, right-click Cliply.exe →
  [Properties] → [Details] and make sure the company is
  "애드소프트 (Addsoft)".

[Language]
  Cliply follows your Windows display language: Korean if Windows is in
  Korean, English otherwise. To change it, right-click the tray icon →
  [Settings] → Language → [Save]. The screens switch immediately.

[Start with Windows]
  Right-click the tray icon → [Settings] → check "Start with Windows"
  → [Save]. If you later move Cliply.exe, run it once from the new
  location so the startup path is updated.


--------------------------------------------------------------
2. Quick search (the main feature)
--------------------------------------------------------------

Whatever program you are using, press Ctrl+Shift+Space and a search box
appears on the screen where your mouse is.

  Key         Action
  ----------  ------------------------------------------------
  Type        Search as you type (up to 30 results)
  Up / Down   Move the selection (wraps around)
  Enter       Copy and close → paste with Ctrl+V in your app
  Esc         Clear the search text, or close if it is empty
  Ctrl+E      Edit the selected snippet in the snippet window
  Ctrl+N      Create a new snippet titled with your search text
  Ctrl+P      Pin / unpin to the top

  - Click a result to select it; double-click to copy it.
  - Clicking outside the search box hides it.
  - You can change the shortcut in Settings.

[Search syntax]

  Input                 Meaning
  --------------------  ------------------------------------
  log tail              Contains all of these words
  #docker               Tagged docker (several tags = all of them)
  @sql                  Language is sql
  "docker logs"         Contains this exact phrase
  #docker @bash logs    Combine any of the above

  - Partial words work too (dock → docker).
  - Results are ordered: pinned → title matches → most used.


--------------------------------------------------------------
3. Variables (the parts of a command that change)
--------------------------------------------------------------

Put {{name}} in a command and Cliply asks for the value when you copy it.

  docker logs -f --tail {{lines:100}} {{container}}

  Syntax            Meaning
  ----------------  ----------------------------------------
  {{name}}          A variable
  {{name:default}}  A variable with a default value
  \{{               A literal {{ (not a variable)

  - If the same name appears several times, you enter it once.
  - Names may use letters, digits, _ and - (Korean letters too).
  - In the input window: Enter = next field (copies on the last field),
    Ctrl+Enter = copy now, Esc = cancel.
  - Cliply remembers the last values you entered and fills them in.

[Automatic variables] Names starting with $ are filled in without asking.

  Syntax                   Value
  -----------------------  ----------------------------------------
  {{$date}}                Today's date (2026-10-24)
  {{$date:yyyyMMdd}}       Custom format (20261024). HH hour, mm minute, ss second
  {{$time}}                Current time (09:05:07)
  {{$datetime}}            Date and time (2026-10-24 09:05:07)
  {{$timestamp}}           Unix time in seconds; {{$timestamp:ms}} for milliseconds
  {{$clipboard}}           What was on the clipboard just before copying
  {{$user}}                Windows user name
  {{$computer}}            PC name
  {{$guid}}                A new GUID ({{$guid:N}} without dashes)
  {{$env:NAME}}            A Windows environment variable (e.g. {{$env:JAVA_HOME}})
  {{$name}}                A global variable you set up in Settings (section 6)
  {{$name:default}}        Value to use if that global variable doesn't exist

  - If a snippet only has automatic variables, it is copied right away.
    If it also has variables to type in, the input window preview shows
    the automatic values already filled in.
  - Unknown names (such as typos) are left as {{$...}} so you notice them.
    Environment variables that don't exist become empty.
  - Example: Copy-Item "{{path}}" "{{path}}.{{$date:yyyyMMdd}}.bak"


--------------------------------------------------------------
4. Snippet window
--------------------------------------------------------------

Double-click the tray icon, or right-click → [Manage snippets].

  Left:  search and list (title, language, tags, pin, times used)
  Right: editor (title, language, tags, command, description)

  Key                    Action
  ---------------------  -----------------------------------
  Ctrl+N                 New snippet
  Ctrl+S                 Save
  Ctrl+P                 Pin / unpin
  Ctrl+F                 Go to the search box
  Del (in the list)      Delete (after confirmation)
  Ctrl+C (in the list)   Copy

  - Tags: type in the tag box and press Enter or a comma (,).
    Existing tags are suggested. Backspace in an empty box removes
    the last tag.
  - Title and command are required. Titles can be up to 200 characters.
  - If you switch snippets or close the window with unsaved changes,
    Cliply asks whether to save them.
  - Closing the window with X keeps Cliply running in the tray.

The first time you run Cliply it adds 24 example snippets in your
language. Delete them if you don't need them.

  - Values you type for variables are saved in Cliply's data on this PC
    so they can be filled in next time. Don't use variables for secrets
    such as API keys or passwords. Ask for them when the command runs
    with Read-Host -AsSecureString, as the example "Set a user environment
    variable permanently" does; then they're neither shown nor stored.


--------------------------------------------------------------
5. Backup and moving (Export / Import)
--------------------------------------------------------------

[Export] at the bottom left of the snippet window saves a JSON file.
[Import] that file on another PC to move your snippets.

  - Before importing, Cliply backs up your current data automatically
    (%LOCALAPPDATA%\Cliply\backup\cliply-date-time.db).
  - If the same snippet exists on both sides, the more recently edited
    one is kept.
  - The result is shown as "Added N / Updated N / Skipped N".


--------------------------------------------------------------
6. Settings
--------------------------------------------------------------

Right-click the tray icon → [Settings]

  - Quick search shortcut: click the box, then press the key combination
    (one or more of Ctrl, Alt, Shift, Win + another key).
    If another program already uses it, Cliply keeps the old one and
    tells you.
  - Start with Windows
  - Show "Copied" after copying
  - Language: Use Windows language / 한국어 / English
  - Theme: Use system setting / Light / Dark
  - Command font: Consolas (D2Coding if it is installed)
  - Global variables: values you use in many snippets, such as a server
    address or account name. Add "name = value" and write {{$name}} in a
    command (e.g. name "server", value "10.0.0.5" → ssh admin@{{$server}}).
    They are saved in export files too, so don't store passwords.


--------------------------------------------------------------
7. Where your data lives
--------------------------------------------------------------

Everything stays on this PC. Nothing is sent over the internet.

  Snippets   %LOCALAPPDATA%\Cliply\cliply.db
  Settings   %LOCALAPPDATA%\Cliply\settings.json
  Logs       %LOCALAPPDATA%\Cliply\logs\  (deleted after 7 days)
  Backups    %LOCALAPPDATA%\Cliply\backup\

  Tip: type %LOCALAPPDATA%\Cliply in the File Explorer address bar.


--------------------------------------------------------------
8. Updating to a new version
--------------------------------------------------------------

  1) Right-click the tray icon → [Exit]
  2) Replace Cliply.exe with the new one
  3) Run it again

Your data is in %LOCALAPPDATA%\Cliply, so it is kept.


--------------------------------------------------------------
9. Uninstalling
--------------------------------------------------------------

  1) In Settings, make sure "Start with Windows" is off → [Save]
  2) Right-click the tray icon → [Exit]
  3) Delete the folder that contains Cliply.exe
  4) To delete your data too, delete %LOCALAPPDATA%\Cliply
     (use [Export] first if you want to keep a copy)


--------------------------------------------------------------
10. FAQ
--------------------------------------------------------------

Q. Nothing happens when I press the shortcut.
A. Check that the tray icon is there. If another program uses the same
   shortcut, Cliply shows a notice at startup. Pick another one in
   Settings.

Q. What happens if I run Cliply.exe again?
A. It doesn't start a second copy; the running Cliply opens its search box.

Q. The first start is a little slow.
A. On the very first run Cliply unpacks some files, which takes 2-3
   seconds. After that it stays in the tray and the search box opens
   instantly.

Q. Copying says "another program is using the clipboard".
A. Up to 0.3.3 this happened often when a clipboard history or sync tool
   was running. Update to 0.3.4. If it still appears, press Enter again
   after a moment.

Q. Something went wrong.
A. Please send us the log file from %LOCALAPPDATA%\Cliply\logs.


--------------------------------------------------------------
 Made by Addsoft (www.addsoft.co.kr)
--------------------------------------------------------------
